FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package ihe.iti.npfs#current (47 ms)

Package ihe.iti.npfs
Type CapabilityStatement
Id Id
FHIR Version R4
Source https://profiles.ihe.net/ITI/NPFS/https://build.fhir.org/ig/IHE/ITI.NPFS/CapabilityStatement-IHE.NPFS.FileConsumerOption.html
Url https://profiles.ihe.net/ITI/NPFS/CapabilityStatement/IHE.NPFS.FileConsumerOption
Version 2.2.1-current
Status active
Date 2022-10-27
Name IHE_NPFS_FileConsumerOption
Title File Consumer (client) implementing Retrieve Document
Experimental False
Realm uv
Authority ihe
Description IHE ITI Non-patient File Sharing (NPFS) - File Consumer (client) - with ITI-109 Retrieve File
Kind requirements

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
IHE.NPFS.DocumentReference NPFS DocumentReference


Narrative

Note: links and images are rebased to the (stated) source

File Consumer (client) implementing Retrieve Document

  • Implementation Guide Version: 2.2.1-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2022-10-27
  • Published by: IHE IT Infrastructure Technical Committee

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: client

CapabilityStatement for File Consumer implementing Retrieve Document

Security

Recommend ATNA, encouraged IHE-IUA or SMART-app-launch

Summary of System-wide Interactions
  • Supports the search-system interaction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
DocumentReferencehttps://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.DocumentReferenceyy_id, identifier, patient, date, author.identifier, format, language, location, status, relatesto, relation, relationship
Binary y

Resource Conformance: supportedDocumentReference

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALLidentifiertoken

Logical identifier of this artifact

SHALLpatienttoken

This parameter shall always be used in this transaction to find resources that do not have the patient element valued, e.g., patient:missing=true

SHALLdatedate

when the file, to which the DocumentReference refers, was submitted

SHALLauthor.identifiertoken

The author that has submitted the file

SHALLformattoken

File's format

SHALLlanguagetoken

The language of the file

SHALLlocationuri

Where the file can be found

SHALLstatustoken

The status of the file

SHALLrelatestoreference

One or more existing DocumentReference Resources that have been replaced by the submitted DocumentReference Resource

SHALLrelationtoken

The type of relation that the file being searched has with the targeted file specified in the relatesTo parameter

SHALLrelationshipcomposite

The combination of the relatesTo and relation search parameter.

 

Resource Conformance: supportedBinary

Core FHIR Resource
Binary
Reference Policy
Interaction summary
  • Supports read.


Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "IHE.NPFS.FileConsumerOption",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">File Consumer (client) implementing Retrieve Document</h2><ul><li>Implementation Guide Version: 2.2.1-current</li><li>FHIR Version: 4.0.1</li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2022-10-27</li><li>Published by: IHE IT Infrastructure Technical Committee</li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as &quot;SHALL NOT&quot;. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div><p>CapabilityStatement for File Consumer implementing Retrieve Document</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Recommend <a href=\"https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html\">ATNA</a>, encouraged <a href=\"https://profiles.ihe.net/ITI/IUA/index.html\">IHE-IUA</a> or <a href=\"http://www.hl7.org/fhir/smart-app-launch/\">SMART-app-launch</a></p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>search-system</code> interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#DocumentReference1-1\">DocumentReference</a></td><td><a href=\"StructureDefinition-IHE.NPFS.DocumentReference.html\">https://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.DocumentReference</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, identifier, patient, date, author.identifier, format, language, location, status, relatesto, relation, relationship</td><td/><td/><td/></tr><tr><td><a href=\"#Binary1-2\">Binary</a></td><td>�</td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DocumentReference1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported</span>DocumentReference</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-IHE.NPFS.DocumentReference.html\">https://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.DocumentReference</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>Logical identifier of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient</td><td><code>token</code></td><td><div><p>This parameter shall always be used in this transaction to find resources that do not have the patient element valued, e.g., patient:missing=true</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>when the file, to which the DocumentReference refers, was submitted</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>author.identifier</td><td><code>token</code></td><td><div><p>The author that has submitted the file</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>format</td><td><code>token</code></td><td><div><p>File's format</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>language</td><td><code>token</code></td><td><div><p>The language of the file</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>location</td><td><code>uri</code></td><td><div><p>Where the file can be found</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>The status of the file</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>relatesto</td><td><code>reference</code></td><td><div><p>One or more existing DocumentReference Resources that have been replaced by the submitted DocumentReference Resource</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>relation</td><td><code>token</code></td><td><div><p>The type of relation that the file being searched has with the targeted file specified in the relatesTo parameter</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>relationship</td><td><code>composite</code></td><td><div><p>The combination of the relatesTo and relation search parameter.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Binary1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported</span>Binary</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/><p/></div></div></div></div>"
  },
  "url" : "https://profiles.ihe.net/ITI/NPFS/CapabilityStatement/IHE.NPFS.FileConsumerOption",
  "version" : "2.2.1-current",
  "name" : "IHE_NPFS_FileConsumerOption",
  "title" : "File Consumer (client) implementing Retrieve Document",
  "status" : "active",
  "experimental" : false,
  "date" : "2022-10-27",
  "publisher" : "IHE IT Infrastructure Technical Committee",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
        }
      ]
    },
    {
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    },
    {
      "name" : "IHE IT Infrastructure Technical Committee",
      "telecom" : [
        {
          "system" : "email",
          "value" : "iti@ihe.net"
        }
      ]
    }
  ],
  "description" : "IHE ITI Non-patient File Sharing (NPFS) - File Consumer (client) - with ITI-109 Retrieve File",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest" : [
    {
      "mode" : "client",
      "documentation" : "CapabilityStatement for File Consumer implementing Retrieve Document",
      "security" : {
        "description" : "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"
      },
      "resource" : [
        {
          "type" : "DocumentReference",
          "profile" : "https://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.DocumentReference",
          "interaction" : [
            {
              "code" : "read"
            },
            {
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "name" : "_id",
              "type" : "token",
              "documentation" : "Logical id of this artifact"
            },
            {
              "name" : "identifier",
              "type" : "token",
              "documentation" : "Logical identifier of this artifact"
            },
            {
              "name" : "patient",
              "type" : "token",
              "documentation" : "This parameter shall always be used in this transaction to find resources that do not have the patient element valued, e.g., patient:missing=true"
            },
            {
              "name" : "date",
              "type" : "date",
              "documentation" : "when the file, to which the DocumentReference refers, was submitted"
            },
            {
              "name" : "author.identifier",
              "type" : "token",
              "documentation" : "The author that has submitted the file"
            },
            {
              "name" : "format",
              "type" : "token",
              "documentation" : "File's format"
            },
            {
              "name" : "language",
              "type" : "token",
              "documentation" : "The language of the file"
            },
            {
              "name" : "location",
              "type" : "uri",
              "documentation" : "Where the file can be found"
            },
            {
              "name" : "status",
              "type" : "token",
              "documentation" : "The status of the file"
            },
            {
              "name" : "relatesto",
              "type" : "reference",
              "documentation" : "One or more existing DocumentReference Resources that have been replaced by the submitted DocumentReference Resource"
            },
            {
              "name" : "relation",
              "type" : "token",
              "documentation" : "The type of relation that the file being searched has with the targeted file specified in the relatesTo parameter"
            },
            {
              "name" : "relationship",
              "type" : "composite",
              "documentation" : "The combination of the relatesTo and relation search parameter."
            }
          ]
        },
        {
          "type" : "Binary",
          "interaction" : [
            {
              "code" : "read"
            }
          ]
        }
      ],
      "interaction" : [
        {
          "code" : "search-system"
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.